/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.security;

import org.springframework.security.core.context.SecurityContext;
import org.springframework.security.core.context.SecurityContextHolder;

/**
 * Implementation of a runnable that makes sure the thread is run in the same
 * security context as the creator, you must implement the call method.
 *
 * @author Morten Olav Hansen <mortenoh@gmail.com>
 */
public abstract class SecurityContextRunnable
    implements Runnable
{
    private final SecurityContext securityContext;

    public SecurityContextRunnable()
    {
        this.securityContext = SecurityContextHolder.getContext();
    }

    @Override
    final public void run()
    {
        try
        {
            SecurityContextHolder.setContext( securityContext );
            before();
            call();
        }
        catch ( Throwable ex )
        {
            handleError( ex );
        }
        finally
        {
            after();
            SecurityContextHolder.clearContext();
        }
    }

    public abstract void call();

    /**
     * Hook invoked before {@link #call()}.
     */
    public void before()
    {
    }

    /**
     * Hook invoked after {@link #call()}.
     */
    public void after()
    {
    }

    public void handleError( Throwable ex )
    {
    }
}
